home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / util / conv / I2SQL.lha / I2SQL-English.doc next >
Encoding:
Text File  |  1995-04-08  |  5.2 KB  |  176 lines
  1.  -------------------------------------
  2. |         I2SQL version 1.0           |
  3.  -------------------------------------
  4.  
  5.  
  6. Introduction
  7. ------------
  8.  
  9.  
  10. This program will only be useful for SQL users who download things
  11. from Aminet (or who use Aminet CD). If you're not in that case you should
  12. close this document and erase this archive because you don't need it at all.
  13.  
  14. I2SQL (for Index to SQL) allows you to convert a standard Aminet Index
  15. file to a script which can be used with SQL database system, like
  16. Oracle or SQLDB.
  17. I programmed it because I didn't want to use grep any more when I wanted to
  18. to search something in my Index files.
  19.  
  20. By the way, I'm a French student so excuse me for my English...
  21.  
  22.  
  23.  
  24. Installation
  25. ------------
  26.  
  27. Copy I2SQL where you want. You can also put an Index file in the same
  28. directory if you want. Put also the file I2SQL.Config in this directory.
  29.  
  30.  
  31.  
  32. Configuration
  33. -------------
  34.  
  35. To use I2SQL, you will need one or two things :
  36.  
  37. - An Amiga (you could use it...)
  38.  
  39. - An Aminet Index : It's a standard Index with descriptions truncated to 42
  40.                     caracters (more or less).
  41.  
  42. - SQL based software (see introduction)
  43.  
  44. - IXEMUL.LIBRARY : It can be found on Aminet or with GCC
  45.  
  46.  
  47. I tested I2SQL 1.0  on an Amiga 1200 + 6 Megs (2 Megs Chip + 4 Megs Fast) converting
  48. the Aminet Index from 10-Mar-95 (ftp.cnam.fr).
  49.  
  50.  
  51.  
  52. Manual
  53. ------
  54.  
  55. From CLI : I2SQL [< Index name >] < Table name >
  56.  
  57. where Index name is the name of your Aminet Index and Table name the name
  58. of the SQL table where you want to put Index into.
  59.  
  60. If Index name is not given I2SQL will work on a file named INDEX in its
  61. current directory.
  62.  
  63. I2SQL has a configuration file. Please note that this file is optionnal. If
  64. it's missing I2SQL will use default values (they are in the demo-file). This
  65. file contains the size of the 4 first fields, one by line. Numbers smaller
  66. than 10 must be preceded by a 0. If you don't respect this rule, and/or you
  67. change the file's structure I2SQL will react in a very, very strange way...
  68. If you want to know how the file is made just have a look at the one in this
  69. archive.
  70.  
  71. The program will display his work on the standard output. If you want to record
  72. conversion in a file you will have to redirect this output to a file (you must
  73. redirect output if you use SQL)
  74.  
  75. Example : I2SQL MyOwnIndex.txt Amy > ImportIndex.sql
  76.  
  77.          Conversion of the file MyOwnIndex.txt in the file ImportIndex.sql
  78.          for the SQL table Amy
  79.  
  80. For SQL import, here is a command to create a table compatible with I2SQL :
  81.  
  82. create table Amy (Name char(19), Path char(12), Size char(6), Age char(4),
  83.                   Desc char(43));
  84.  
  85.  
  86. By the way, to avoid problems, redirect output in a file located in RAM:
  87. (I2SQL Index.txt Amy > Ram:Import.sql). It will prevent your hard disk from being
  88. damaged if the program crashes during an execution (I did not have this problem
  89. on my computer but ...)
  90.  
  91. IMPORTANT NOTE : Don't redirect output to the file you are converting. You could
  92.                  loose your Index file or damage your disk.
  93.  
  94.  
  95.  
  96. Disclaimer
  97. ----------
  98.  
  99. This piece of software has been tested on a A1200 .You use it at your
  100. own risks and I can't be responsible if it destroys your hard disk, doesn't
  101. work on your Amiga 9000 + 68095 card or has a very strange behavior
  102. if you don't use it in the right way.
  103.  
  104. Seriousely, I decline responsabilities in case of big problem caused by I2SQL.
  105. Due to the algorithms I use it can't break anything IF YOU FOLLOW THE INSTRUCTIONS
  106. GIVEN IN THIS MANUAL. If there is an unclear passage , contact me.
  107.  
  108.  
  109. Distribution
  110. ------------
  111.  
  112. I2SQL is FREEWARE. But I keep a copyright on it.
  113.  
  114. You can diffuse it and use it freely if the archive is kept intact
  115. and if you don't put a virus in it.
  116.  
  117. Aminet, Fred Fish and Amiga magazines are allowed to include this program
  118. in their collections (Floppy disks or CD ROM).
  119. Public Domain organisations also have this authorization if the price of the disk stays normal.
  120. France Festival Distribution WILL NEVER BE ALLOWED to diffuse I2SQL.
  121.  
  122.  
  123. History
  124. -------
  125.  
  126.  
  127.     March 1995  :   Beta Version 1
  128.                     Version not released
  129.  
  130.     April 1995  :   Version 1.0
  131.                     Some internal bugs fixed.
  132.                     Initial release.
  133.  
  134.  
  135. Author
  136. ------
  137.  
  138.  
  139. I2SQL has been created by :
  140.  
  141.             Mr Franck Anière
  142.             30, Rue Jean Bouin
  143.             93220 GAGNY
  144.  
  145.             E-Mail : aniere@massena.univ-mlv.fr
  146.                      aniere@fillmore.univ-mlv.fr
  147.                      aniere@univ-mlv.fr (if the 2 others don't work)
  148.  
  149.  
  150. You can join me for comments, critics, suggestions and bug report
  151. (Enforcer Hits are welcome, I don't have MMU!).
  152.  
  153. I don't know very well how SQL works. So if I2SQL doesn't work don't
  154. hesitate to tell me what's wrong in the generated file.
  155.  
  156. I would be happy to work on a converter for another Database Software.
  157. If you are interested send me a detailled description of the format
  158. used by the program for the ASCII import or a demo-version (I MEAN
  159. A LEGAL FREELY DISTRIBUABLE DEMO, NOT A CRACKED SOFTWARE).
  160.  
  161.  
  162.  
  163. Projects
  164. --------
  165.  
  166. I think I will add the following features :
  167.  
  168.         - Direct file output
  169.  
  170.         - Possibility to choose quantity of fields
  171.  
  172. And any other suggestion I will think it is interesting and makeable
  173. (After all I'm just a student and I don't have much free time !)
  174.  
  175.  
  176.